home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / DATABASE / MINIHOUND / !MiniHound / !Help next >
Text File  |  1993-01-12  |  14KB  |  339 lines

  1.  
  2.  
  3.            Mini Hound                        © copyright 1993, Ian Palmer
  4.            ——————————                                 version 1.00
  5.  
  6.       Mini Hound is SHAREWARE
  7.       ———————————————————————
  8.  
  9. See the file called '!Licence' (included in the application directory) for
  10. details of the user licence for Mini Hound.
  11.  
  12. Mini Hound is a cut down, single disc, version of Word Hound. Mini Hound
  13. supplies the user with a cut down Roget’s thesaurus (taken from Roget’s 1911
  14. thesaurus).
  15.  
  16. Although it is a cut down version, it none the less contains over 30,000 key
  17. words which index into a thesaurus with almost 60,000 words. Adding the fact
  18. that Mini Hound performs a unique ‘fuzzy’ search every time the number of
  19. actual words it can find is much greater.
  20.  
  21. The full Word Hound application, however, comes with a larger thesaurus, and
  22. also a full dictionary containing over 30,000 definitions. The larger
  23. thesaurus contains alternative phrases as well as alternative words, for
  24. example searching for ‘express’ you will get words like ‘convey’, ‘imply’
  25. and ‘indicate’ (as well as many others) with both packages, but with Word
  26. Hound you will also get ‘bear a sense’, ‘speak of’ and ‘allude to’ (as well
  27. as others).
  28.  
  29. With the full Word Hound you can also, of course, get a full definition of
  30. ‘express’ :
  31.  
  32. ———————— Actual definition as given by Word Hound ———————-
  33.  
  34. 1 ex.press \ik-‘spres\ adj
  35.   1: EXPLICIT; also : EXACT, PRECISE
  36.   2: SPECIFIC <his express purpose>
  37.   3: traveling at high speed and usu. with few stops <express train;
  38.      also : adapted to high speed use <express roads>
  39.   4: being or relating to special transportation of goods at premium
  40.      rates <express delivery> <express rates>
  41.   — ex.press.ly adv
  42.  
  43. 2 express n : an express system or vehicle
  44.  
  45. 3 express vb
  46.   1: to make known : SHOW, STATE <express regret> <express himself
  47.      through art :; also : SYMBOLIZE
  48.   2: to squeeze out : extract by pressing
  49.   3: to send by express
  50.  
  51. —————————- End of definition from Word Hound ————————-
  52.  
  53. Further details of the full Word Hound application are given in a separate
  54. file supplied with this application.
  55.  
  56. Both Mini Hound and it’s big brother Word Hound will communicate directly
  57. with Computer Concepts’ Impression document processor (version 2.17), and
  58. will also communicate (although not directly) with almost any editor or word
  59. processor, etc. Of course they also work on their own, providing a fast and
  60. convenient way of locating that word that’s on the edge of your tongue.
  61.  
  62. _____________________
  63. —————————————————————
  64. Mini Hound User Guide
  65. _____________________
  66. —————————————————————
  67.  
  68. When you run Mini Hound it will install itself on the iconbar as normal.
  69. Clicking ‘Select’ on it’s icon brings up the ‘Enter’ window which is where
  70. you can enter words for Mini Hound to search.
  71.  
  72. This window contains 5 icons :
  73.  
  74. 1) A writable icon where you can type words
  75.  
  76. 2) A menu icon marked ‘Search’ which will make Mini Hound search for the
  77. word currently in the writable icon.
  78.  
  79. 3) A menu icon marked ‘Wild Card’ which makes Mini Hound perform a wild card
  80. search (see below).
  81.  
  82. 4) A menu icon marked ‘Sounds Like’ which makes Mini Hound perform a sounds
  83. like search (see below).
  84.  
  85. 5) An option icon marked ‘Close’ which sets the window close option of Mini
  86. Hound (see below).
  87.  
  88.  
  89. Normal Search
  90. —————————————
  91.  
  92. When Mini Hound is asked to perform a normal ‘Search’, it looks the given
  93. word up in it’s index file. It then brings up a ‘Selection’ window which
  94. will either contain a message stating that the word could not be found, or a
  95. list of thesaurus entries which contain that word.
  96.  
  97. If a list is produced, the list gives the first word in each relevant entry.
  98. To view the complete entry for any in the list simply move the mouse pointer
  99. over that entry and press the ‘Select’ mouse button.
  100.  
  101. At this point the ‘Display’ window will pop up giving the full entry. On
  102. this window moving the mouse pointer over a word and pressing mouse buttons
  103. perform the following functions :
  104.  
  105. Select        - Pass the word under the pointer to the application
  106.                 currently holding the caret.
  107.  
  108. Menu          - Bring up a save window to allow you to save the entry
  109.                 to a text file.
  110.  
  111. Adjust        - Perform a normal search on the word under the pointer.
  112.  
  113. Shift-Adjust  - Place the word under the pointer in the writable icon in the
  114.                 ‘Enter’ window.
  115.  
  116.  
  117. NOTES:
  118.  
  119. When you bring up the ‘Enter’ window, Mini Hound first notes where the caret
  120. is, and will return it there when a search takes place.
  121.  
  122. When a normal search is performed, in actual fact a ‘fuzzy’ search is
  123. performed. This search also looks for words that are very similar, or of the
  124. same stem as the word searched for. For example searching for ‘fastest’ will
  125. also search for ‘fast’, searching for ‘colour’ will also search for ‘color’
  126. (to make up for the fact that the thesaurus is American), etc.
  127.  
  128. The list produced in the ‘Selection’ window contains two columns. The first
  129. column indicates the word found in the index files, the second column gives
  130. the first word in the thesaurus entry. Due to the use of the fuzzy search
  131. words other than the one you typed in can appear in the selection list. For
  132. example, searching for 'card' will also produce an entry for 'car'.
  133. Irrelevant search entries should just be ignored by the user.
  134.  
  135.  
  136. Wild Card and Sounds Like searches
  137. ——————————————————————————————————
  138.  
  139. The ‘Wild Card’ search allows you to search for words by giving wild cards.
  140. Both the * and # wild cards are fully supported, * meaning any number of
  141. letters and # meaning any single letter.
  142.  
  143. The ‘Sounds Like’ search will look for all words that sound like the word
  144. given. For example, a sounds like search on ‘word’ produces the following :
  145.  
  146.     rowdy ward wart weird wiedo word wordy work
  147.  
  148. This sounds like search is very useful if you can only roughly remember a
  149. word, or don’t know how it is spelt.
  150.  
  151. With both these searches the resultant list is given in the ‘Display’ window
  152. (described above) and the mouse has the same function as with the display of
  153. thesaurus entries.
  154.  
  155.  
  156. Mini Hound with Impression™
  157. ——————————————————————————-
  158.  
  159. Mini Hound will hotlink with Impression allowing you to pass words between
  160. the two applications. For the hotlink to work Mini Hound’s ‘Enter’ window
  161. must be open (it can be iconised, under Risc-OS 3). To pass a word from
  162. Impression to Mini Hound simply select that word inside your Impression
  163. document and then press SHIFT-INSERT. Mini Hound will then perform a normal
  164. search on that word, bringing up the ‘Selection’ window as normal.
  165.  
  166. If, instead of pressing SHIFT-INSERT you press CTRL-SHIFT-INSERT Mini Hound
  167. will simply enter the selected word into the writable icon in the ‘Enter’
  168. window, allowing you to perform other searches on the word.
  169.  
  170. When you have located the word you wish to replace the searched word for,
  171. simply press ‘Select’ over that word (in the ‘Display’ window‘) and it will
  172. be passed directly to Impression which will perform the substitution.
  173.  
  174. Notes:
  175.  
  176. This hotlink only works with Impression version 2.17 (and probably above,
  177. but no responsibility can be taken for Computer Concepts changing the
  178. hotlinking system in future releases of Impression).
  179.  
  180. If more than one word is selected in the Impression document, the first word
  181. in the selection will be searched by Mini Hound.
  182.  
  183. Impression takes over the handling of trying to match the case of the
  184. replacement word passed to it by Mini Hound, and thus this feature will not
  185. always be the same as handled when using Mini Hound with other applications
  186. (see below).
  187.  
  188.  
  189. Mini Hound with other applications
  190. ——————————————————————————————————
  191.  
  192. With applications other than Impression a slightly more cumbersome method
  193. can be employed. To pass a word to Mini Hound you can drag a ‘Save
  194. Selection’ (or similar) to either Mini Hound’s iconbar icon, or it’s ‘Enter’
  195. window, and it will perform a search on that word.
  196.  
  197. Passing words from Mini Hound to the other application you must make sure
  198. that the caret is in the correct position in the other application’s window
  199. and then ‘Select’ the word you wish to pass in Mini Hound’s ‘Display’ window.
  200.  
  201. When passing words to Mini Hound from other applications, Mini Hound makes a
  202. note of the case of the word passed. Mini Hound can identify 3 distinct
  203. cases, all lower case, all upper case and first letter upper the rest lower
  204. case. When you select a word to send back to the application Mini Hound will
  205. try to match the case of the new word to that of the word passed to it.
  206. Note, as stated above, when using the Impression hotlink this is handled by
  207. Impression itself, and so the results may be different in some cases.
  208.  
  209.  
  210. Mini Hound Close Window Option
  211. ——————————————————————————————
  212.  
  213. When you select a word in Mini Hound’s ‘Display’ window you may wish Mini
  214. Hound to automatically close it’s windows (the selection and display
  215. windows), this can be done by setting the ‘Close’ option in the ‘Enter’
  216. window.
  217.  
  218.  
  219. Mini Hound’s Window Colours
  220. ——————————————————————————-
  221.  
  222. Mini Hound uses five user definable colours for it’s selection and display
  223. windows. These colours can be set by the user from the main menu. The five
  224. colours are identified by the following :
  225.  
  226. Background  - Background of the windows
  227. Foreground  - Colour of main text in the display window
  228. Dictionary  - Not really relevant to Mini Hound
  229. Word        - Colour used for highlighting searched for word in display
  230. window.
  231. Select      - Colour used for highlighting selected word in display window.
  232.  
  233.  
  234. Saving your options
  235. ——————————————————-
  236.  
  237. You can save your window colour, and Close window, options by using the save
  238. status entry in the main menu. This status file is a text file which you can
  239. edit if you wish, although it is easier to get Mini Hound to create its own.
  240.  
  241. When Mini Hound starts up it looks for a file pointed to by the system
  242. variable MiniHound$Init. By default this points to a file called ‘SetUp’ in
  243. the MiniHound application directory, this is the file that is created with
  244. the save status option in Mini Hound.
  245.  
  246. The file is basically a list of options, each having two parts; an option
  247. name and a value.
  248.  
  249. Option names available are (with meanings) :
  250.  
  251.   Hot-Search          - Key code to initiate Impression hotlink ‘search’
  252.   Hot-Enter           - Key code to initiate Impression hotlink ‘enter’
  253.   Background          - Colour of window backgrounds
  254.   Foreground          - Colour of window foreground
  255.   Dictionary          - Colour of to display the word ‘Rogette’ in windows
  256.   Word                - Colour of highlighting searched word
  257.   Select              - Colour of highlighting selected word
  258.   Auto-Close          - Auto window close option
  259.  
  260. The option is then followed by a ‘:’ and then a value. All options can take
  261. numerical values as their parameters, but there are some special cases.
  262.  
  263. Auto-Close can also take any of : On Off True False
  264. Hot-Search and Hot-Enter can also take descriptions, eg. :
  265.  
  266.    Shift Insert
  267.    Ctrl F1
  268.    Ctrl-T
  269.    Shift Ctrl Copy
  270.  
  271. and so on. When Mini Hound creates the file it uses the numerical form for
  272. all options except Auto-Close where it will use either True or False.
  273.  
  274. Note: If you want to change the keys for the Impression hotlink (from their
  275. default SHIFT-INSERT and CTRL-SHIFT-INSERT) you must make sure that your
  276. replacements are key combinations not already understood by Impression. This
  277. does rather limit the range of choice, as Impression has used most key
  278. combinations already.
  279.  
  280.  
  281. Requirements
  282. ———————————-
  283.  
  284. The Mini Hound application has been designed to fit onto a single 800k disc
  285. so as to work on any Risc-OS computer. It’s memory requirements vary during
  286. use. When idle Mini Hound requires 128k memory. However when it is
  287. displaying the results of a search it’s memory requirements will grow
  288. depending on what it is trying to display. Under typical use the memory
  289. requirements are unlikely to rise above 160k in total.
  290.  
  291. Although Mini Hound will work from a floppy disc, it is faster from a hard
  292. disc. For example, searching for ‘waiting’ from floppy (on an A5000) takes
  293. approx. 3-4 seconds from floppy, whereas the search is instantaneous from a
  294. hard drive.
  295.  
  296. As another example a sounds like search on ‘anxious’ takes about 9 seconds
  297. from floppy, but only about 1 second from a hard disc. Finally, searching
  298. for ‘*na’ from floppy takes almost half a minute - but on hard disc it’s
  299. just 2 seconds.
  300.  
  301.  
  302. Notes
  303. —————
  304.  
  305. The thesaurus used by this program is based on an American version of
  306. Roget's thesaurus, and thus contains some American specific words and
  307. spellings (eg. color). Although Mini Hound makes some compensations for this
  308. during it's normal search it should, however, be kept in mind.
  309.  
  310. The thesaurus was created automatically from a much larger text, and
  311. contains a few rogue entries. These entries are usually confined to common
  312. words such as 'the' and 'with' which can appear in word lists where they do
  313. not belong.
  314.  
  315.  
  316. The Guided Tour
  317. ———————————————
  318.  
  319. Often with new applications it is helpful to follow an example run to get
  320. familiar with the porgram. A tutorial is supplied with this application for
  321. this very purpose. The tutorial is contained in a text file on this disc,
  322. called 'Tutorial'.
  323.  
  324.  
  325. Technical Details
  326. —————————————————
  327.  
  328. It is not advised to run this application from within archives or compressed
  329. filing systems (eg. ArcFS, CFS or SparkFS, etc.) as this will slow down the
  330. application dramatically. As the data files (over 80% of the application)
  331. are already compressed placing Mini Hound in an archive (or compressing it)
  332. has a reduced effect.
  333.  
  334. Data files designed to work with Word Hound (Mini Hound's big brother) are
  335. not compatable with Mini Hound, and vice versa.
  336.  
  337. Unlike Word Hound, the Mini Hound thesaurus can not be updated by the user.
  338.  
  339.